Skip to content

Conversation

@yelizhenden-mdb
Copy link
Collaborator

@yelizhenden-mdb yelizhenden-mdb commented Feb 21, 2025

Proposed changes

Jira ticket: CLOUDP-288870

The script is changed as:

  • The new collection name will start with ⭐️
  • If the collection is created in the workspace first time, it will check if a collection with a star icon already exists. If so, it will modify the name removing the star icon

Testing

I've run the commands against an empty workspace, and it created the collection with the star in the name.

Screenshot 2025-02-21 at 17 50 01

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works

Changes to Spectral

  • I have read the README file for Spectral Updates

Further comments

@yelizhenden-mdb yelizhenden-mdb marked this pull request as ready for review February 21, 2025 17:50
@yelizhenden-mdb yelizhenden-mdb requested a review from a team as a code owner February 21, 2025 17:50
echo "Updating name with version $current_api_revision"
jq --arg api_version "$current_api_revision" \
'.collection.info.name = ("MongoDB Atlas Administration API " + $api_version)' \
'.collection.info.name = ("MongoDB Atlas Administration API " + $api_version)' \
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'.collection.info.name = ("MongoDB Atlas Administration API " + $api_version)' \
'.collection.info.name = ("[Latest] MongoDB Atlas Administration API " + $api_version)' \

I am wondering why we went for the ⭐ . Isn't clearer to use Latest instead?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The discussion started with using ⭐. I'm fine with changing it to [Latest]. Has there been a product decision on this? cc @matt-condon

Copy link
Member

@wtrocki wtrocki Feb 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yelizhenden-mdb Feel free to go ahead and use latest as star might not be universally recognizable across the globe as "first"/"latest".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rationale behind the ⭐ is there's a precedent for it and it probably stands out a bit more
I'm fine with [latest] but probably not [first]

Do we generally have a way that we denote the latest API version across docs for consistency?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disscussed offline. ⭐ is the visual clue we want :)

Copy link
Member

@wtrocki wtrocki left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yelizhenden-mdb We need to make change to js transformer as well, but happy to do it myself as I have introduced duplication

@yelizhenden-mdb yelizhenden-mdb merged commit af47092 into main Feb 24, 2025
12 checks passed
@yelizhenden-mdb yelizhenden-mdb deleted the CLOUDP-288870 branch February 24, 2025 12:26
@wtrocki
Copy link
Member

wtrocki commented Feb 24, 2025

Creating follow up PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants